home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1534.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  4.4 KB  |  187 lines
  1. 129
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. CopyFileProgress 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baCopyFileProgress copies a file, while displaying a progress dialog
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baCopyFileProgress( SourceFile , DestFile , Overwrite, Title, ButtonText, 
  28. --- RECORDSEPARATOR ---
  29. Flags )
  30. --- RECORDSEPARATOR ---
  31.  
  32. --- RECORDSEPARATOR ---
  33. Arguments:
  34. --- RECORDSEPARATOR ---
  35.  
  36. --- RECORDSEPARATOR ---
  37. String, string, string, string, string, integer. 
  38. --- RECORDSEPARATOR ---
  39. SourceFile is the file to copy. 
  40. --- RECORDSEPARATOR ---
  41. DestFile is the name to copy it to. 
  42. --- RECORDSEPARATOR ---
  43. Overwrite determines how the copy is done. Can be: 
  44. --- RECORDSEPARATOR ---
  45. "Always" 
  46. --- RECORDSEPARATOR ---
  47. always copie
  48. --- RECORDSEPARATOR ---
  49. s the file 
  50. --- RECORDSEPARATOR ---
  51. "IfNewer" 
  52. --- RECORDSEPARATOR ---
  53. copies the file if SourceFile is newer than DestFile 
  54. --- RECORDSEPARATOR ---
  55. "IfNotExist" 
  56. --- RECORDSEPARATOR ---
  57. copies only if DestFile does not already exist 
  58. --- RECORDSEPARATOR ---
  59. Title is the title of the dialog box. 
  60. --- RECORDSEPARATOR ---
  61. ButtonText is the text to use in the Cancel button. 
  62. --- RECORDSEPARATOR ---
  63. Flags changes the behaviour of the dialog, see notes for details.
  64. --- RECORDSEPARATOR ---
  65.  
  66. --- RECORDSEPARATOR ---
  67. Returns:
  68. --- RECORDSEPARATOR ---
  69.  
  70. --- RECORDSEPARATOR ---
  71. Integer. 
  72. --- RECORDSEPARATOR ---
  73. Returns 0 if the file was copied successfully, otherwise one of these: 
  74. --- RECORDSEPARATOR ---
  75. 1 
  76. --- RECORDSEPARATOR ---
  77. Invalid Source file name 
  78. --- RECORDSEPARATOR ---
  79. 2 
  80. --- RECORDSEPARATOR ---
  81. Invalid Dest file name 
  82. --- RECORDSEPARATOR ---
  83. 3 
  84. --- RECORDSEPARATOR ---
  85. Error reading the Source file 
  86. --- RECORDSEPARATOR ---
  87. 4 
  88. --- RECORDSEPARATOR ---
  89. Error writing the Dest file 
  90. --- RECORDSEPARATOR ---
  91. 5 
  92. --- RECORDSEPARATOR ---
  93. Couldn't create directory for Dest file 
  94. --- RECORDSEPARATOR ---
  95. 6 
  96. --- RECORDSEPARATOR ---
  97. Dest file exists 
  98. --- RECORDSEPARATOR ---
  99. 7 
  100. --- RECORDSEPARATOR ---
  101. Dest file is newer that Source file 
  102. --- RECORDSEPARATOR ---
  103. 9 
  104. --- RECORDSEPARATOR ---
  105. User cancelled the copy
  106. --- RECORDSEPARATOR ---
  107.  
  108. --- RECORDSEPARATOR ---
  109. Examples:
  110. --- RECORDSEPARATOR ---
  111.  
  112. --- RECORDSEPARATOR ---
  113. Director: 
  114. --- RECORDSEPARATOR ---
  115. OK = baCopyFileProgress( "c:\data\student.dat" , "c:\data\backup\student.dat" , 
  116. --- RECORDSEPARATOR ---
  117. "If
  118. --- RECORDSEPARATOR ---
  119. Newer", "Backing up files... ", "Cancel", 0 ) 
  120. --- RECORDSEPARATOR ---
  121. Authorware: 
  122. --- RECORDSEPARATOR ---
  123. OK := baCopyFileProgress( "c:\\data\\student.dat" , "c:\\data\\backup\\student.dat" , 
  124. --- RECORDSEPARATOR ---
  125. "IfNewer" , "Backing up files... ", "Cancel", 0 )
  126. --- RECORDSEPARATOR ---
  127.  
  128. --- RECORDSEPARATOR ---
  129. Notes:
  130. --- RECORDSEPARATOR ---
  131.  
  132. --- RECORDSEPARATOR ---
  133. By default, this function will not overwrite an existing file if that file is marked as 
  134. --- RECORDSEPARATOR ---
  135. read-only. However, on Windows, by adding 
  136. --- RECORDSEPARATOR ---
  137. "
  138. --- RECORDSEPARATOR ---
  139. +
  140. --- RECORDSEPARATOR ---
  141. " 
  142. --- RECORDSEPARATOR ---
  143. to the 
  144. --- RECORDSEPARATOR ---
  145. "
  146. --- RECORDSEPARATOR ---
  147. Always
  148. --- RECORDSEPARATOR ---
  149. " 
  150. --- RECORDSEPARATOR ---
  151. and 
  152. --- RECORDSEPARATOR ---
  153. "
  154. --- RECORDSEPARATOR ---
  155. IfNewer
  156. --- RECORDSEPARATOR ---
  157. " 
  158. --- RECORDSEPARATOR ---
  159. options (eg "Always+" or "IfNewer+"), the destination f
  160. --- RECORDSEPARATOR ---
  161. iles will be overwritten if they 
  162. --- RECORDSEPARATOR ---
  163. are read-only. 
  164. --- RECORDSEPARATOR ---
  165. A return value of 6 (Dest file exists) can only be returned when Overwrite is 
  166. --- RECORDSEPARATOR ---
  167. "IfNotExist". 
  168. --- RECORDSEPARATOR ---
  169. A return value of 7 (Dest file is newer than Source file) can only be returned when 
  170. --- RECORDSEPARATOR ---
  171. Overwrite is "IfNewer". The other return values can be returned for all Overwrite 
  172. --- RECORDSEPARATOR ---
  173. options. 
  174. --- RECORDSEPARATOR ---
  175. The "IfNewer" option operates as follows: if both files have internal version 
  176. --- RECORDSEPARATOR ---
  177. numbers, then these numbers are used for comparison, otherwise the dates of the 
  178. --- RECORDSEPARATOR ---
  179. two files are used for comparison. 
  180. --- RECORDSEPARATOR ---
  181. The DestFile must contain the full name of the file, not just the name of the folder it 
  182. --- RECORDSEPARATOR ---
  183. is being copied to.
  184. --- RECORDSEPARATOR ---
  185.  
  186. --- RECORDSEPARATOR ---
  187. (continued next page)